home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / clipper / ks94an.zip / TEXTBROW.HDR < prev    next >
Text File  |  1994-04-25  |  2KB  |  58 lines
  1. /******************************************************************************
  2.                  The Klipper Library, for CA-Clipper 5.x
  3.         Copyright (c), 1994, Wallace Information Systems Engineering
  4.  
  5. FUNCTION:
  6.  
  7. _TextBrowse(nFRow, nFCol, nTRow, nTCol, cVar, nBoxType, nBoxLabel, cLabelStr,
  8. cColor, lViewOnly ) --> NIL
  9.  
  10. PARAMETERS:
  11.  
  12. nFRow    : Box Top Left Row
  13. nFCol    : Box Top Left Col
  14. nTRow    : Box Bottom Right Row
  15. nTCol    : Box Bottom Right Column
  16. cVar     : Text to Browse
  17. nBoxType : Box Line Type
  18. nBoxLabel: Label Type to use
  19. cLabelStr: Label String to use
  20. cColor   : Color for Display
  21. lViewOnly: If TRUE, displays text without pausing for panning
  22.            or paging up or down.
  23.  
  24. SHORT:
  25.  
  26. General Purpose text browse.
  27.  
  28. DESCRIPTION:
  29.  
  30. _TextBrowse() displays a freeform text inside the specified coorinates.
  31.  
  32. If Box Border Type is BOXNONE (no border), then the area that would have
  33. been the border is given to the display area, and no box shadow is drawn.
  34.  That is, if there is no border, the function will use the border
  35. line coordinates as additional display area.
  36.  
  37. See _Box() for description of Box and Label types.
  38.  
  39. NOTE:
  40.  
  41. KLIPDOCS.EXE uses _TextBrowse() to display the function, parameter, short,
  42. description, note and example texts.  If you are reading this on-line (not
  43. editing), you are looking at an example of _TextBrowse().
  44.  
  45. EXAMPLE:
  46.  
  47. cText = DATABASE->MEMFIELD
  48.  
  49. _TextBrowse(10,10,17,40,cText,5)
  50.  
  51. Result:
  52.  
  53. The text contained in the database field MEMFIELD is fitted and displayed in
  54. a thick bordered box.  Up and down arrow keys, PgUp and PgDn keys move
  55. through the text, ESC exits.
  56.  
  57. ******************************************************************************/
  58.